/*
 *  Copyright (C) 2010 Glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Nesta anotação estão definidas as propriedades para os filtros encapsuladas
 * em uma entidade associada que poderá ser selecionada.
 *
 * @author Glauco
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface CriteriaSelection {
    
    /**
     * Representa os nomes para construção do filtro.
     * @return Retorna as alias.
     */
    public String[] alias() default "";

    /**
     * Indice do filtro.
     * Os filtros encapsuladas terão os seus indices adicionadas o valor deste
     * indice.
     * @return Retorna o indice do filtro.
     */
    public int index() default 0;

    /**
     * Alias dos filtros encapsulado em uma entidade associada.
     * As definições dos filtros encapsulado serão adicionados aos filtros desta
     * definição.
     * @return Retorna o Alias (nome) do filtro encapsulado em um entidade
     * Associada.
     */
    public String filter() default "";

    /**
     * Alias para uma busca da entidade encapsulada.
     * @return Retorna o alias de uma busca para entidade encapsulada.
     */
    public String search() default "";

    /**
     * Mensagem para ser mostrada para quando nenhuma entidade atender as
     * condições da seleção.
     * @return Retorna uma mensagem de entidade não encontrada.
     */
    public String notFoundMessage();

    /**
     * Propriedades adicionais para a definição.
     */
    public Property[] properties() default {};
}
